XIQS Add Device to SIP Device Group

From IQsimWiki

Jump to: navigation, search


XIQS Add Device to Device Group - SIP Devices Management

Description
addXIQSVoipDvcGroup ( Long group_id , Long device_id , String port_map )
Add device into existing device group.


Parameters

Long group_id

Device group ID

Long device_id

Device ID

String port_map

Device port map, used only when device type is GSM Device. Each port is represented with "0" (port is not in the group) or "1" (port is in the group). Port 0 is right most. Example: "01100011" means that ports 0,1,5 and 6 are inside group.
Return Values
Return Code
Integer: OK = 1

Error Data structure ( Error Management )

Possible failure code returns
*ERR_UNAUTHORIZED (401) ERR_MSG_DVCGRP_NO_ICM
*ERR_UNAUTHORIZED (401) ERR_MSG_CMGR_IN_USE
*ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB
See Also

createXIQSVoipDvcGroup

Example

This command will add device with ID=15 into group with ID=23. GSM Ports 0,4,5,6 and 7 will be part of the group

<?xml version="1.0" encoding="UTF-8">
<command tid="0001" name="addXIQSVoipDvcGroup">
  <param type="long">23</param>
  <param type="long">15</param>
  <param type="string">11110001</param>
</command>

This command will add device with ID=25 into group with ID=33. This device doesn't have GSM Ports (for example device is VoIP Trunk) so last parameter is empty

<?xml version="1.0" encoding="UTF-8">
<command tid="0001" name="addXIQSVoipDvcGroup">
  <param type="long">33</param>
  <param type="long">25</param>
  <param type="string"></param>
</command>

[ANSWER (OK)]
<?xml version="1.0" encoding="UTF-8"?>
<event type="return" tid="0001">
  <meta-data>
    <meta-value>
      <name>ret_code</name>
      <pos>1</pos>
    </meta-value>
  </meta-data>
  <param type="integer">1</param>
</event>

[ANSWER (Error)]
<?xml version="1.0" encoding="UTF-8"?>
<event type="error">
  <meta-data>
    <meta-value><name>err_code</name><pos>1</pos></meta-value>
    <meta-value><name>err_desc</name><pos>2</pos></meta-value>
  </meta-data>
  <param type="integer">401</param>
  <param type="string">err.dvcgrp.noicm.allowed</param>
</event>

Personal tools
Namespaces
Variants
Views
Actions
Navigation
XIQS XML Protocol
XIQS Framework Libraries
XIQS Command List